Rewrite Readme - #19
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the project’s README to reflect the current intended positioning of the repository (educational/experimental RSA primitives) and to provide basic integration and usage guidance for the C++20/CMake library.
Changes:
- Rewrote the README overview to describe the exposed types (
core::Encryptor,core::Decryptor,PublicKey,PrivateKey,keyPair) and the Base256 dependency. - Added “Installation and Integration” guidance (clone with submodules + CMake
add_subdirectoryusage). - Added a basic C++ usage example and a short architecture section.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| #include <vector> | ||
|
|
||
| int main() { | ||
| keyPair keys; |
Comment on lines
+59
to
+60
| - `keyPair` owns the current public/private key data and provides serialization | ||
| helpers. |
Comment on lines
+20
to
+26
| To integrate the library into another CMake project, add this repository as a | ||
| subdirectory and link against the `RSA` target: | ||
|
|
||
| ```cmake | ||
| add_subdirectory(path/to/RSA-Encryptor) | ||
| target_link_libraries(YourTarget PRIVATE RSA) | ||
| ``` |
SecondJochen
reviewed
Jul 2, 2026
SecondJochen
suggested changes
Jul 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Please review in detail, if information is actually correct